<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <title>Compiling JJSched Documentation</title>
        <link rel="stylesheet" type="text/css" href="style.css" />
    </head>

    <body>
        <h1>Compiling JJSched Documentation</h1>
        <!---header--->

        <p>This short guide leads you through compiling the JJSched documentation.</p>
        <p>Note: <b>You don't need to generate your own documentation unless you modify JJSched. The information here
        is provided only to document the whole JJSched creation process.</b></p>
        <p>The documentation consists of three parts:</p>
        <ul>
            <li>The html documentation (which the document you're reading at the moment belongs to)</li>
            <li>Javadoc documentation</li>
            <li>Source code generated by java2html</li>
        </ul>

        <h2>Generating the html documentation</h2>
        <p>The html documentation is generated by the bash script genhtml.sh in the ./documentationtemplates directory.
        It searches this directory and converts the *.htmp template files to template output files, replacing each occurence
        of #DATE# in the *.htmp file by the current date. The template output files are then pasted into the *.html files
        in the documenationtemplates directory. You denote the place for these output files by placing &lt;!---name---&gt;
        into the *.html file, where you replace the "name" with the base name of the *.htmp file. For example, if you
        want to place a header into your *.html files, you create a header.htmp file with contents of this header and
        put &lt;!---header---&gt; in your *.html files, wherever you want the header to be placed.</p>
        <p>The processed *.html files are placed into the folder ./documentation, but this can be changed in the genhtml.sh
        script</p>

        <h2>Javadoc documentation</h2>
        <p>This documentation is generated simply by executing the documentation ant task. It copies the generated files
        to the ./documentation/javadoc directory</p>

        <h2>Source code documentation</h2>
        <p>The source code is generated by the java2html application. If you have it installed, type "j2h -s ./src -d ./documentation/source"
        to generate the source code documentation.</p>

    <!---footer--->
    </body>
</html> 
